<?php


namespace frontend\controllers;

use yii\web\Controller;

/**
 * Doc Class
 * 多行多好
 * 多行多好
 * 多行多好结尾
 */
class DocController extends Controller
{
    /**
     * 接口名称
     *
     * 这是描述这是描述这是描述，这是描述
     * 多行描述
     * 很多行描述
     *
     * @namespace /ddd/fff/或中文 //目录结构，用于文档平台菜单等地方
     * @author chen //作者
     * @create_time 2019/9/19 //创建时间
     * @protocol http //请求协议
     * @host ms.geto.pro //接口官方域名，测试域名应由测试用例中自己修改
     * @url /site/post-form-method //请求资源地址
     * @method POST //请求类型
     * @header 键名1 键值1 描述描述
     *       描述描述描述描述描述描述
     *       很多很多描<a href="/ddd/fff/234" target="_blank">述描述描述</a>描述描述描述描述描述描述描述
     * @header 键名2 键值2 描述
     * @param_query string[len=10,30|required=1|default=123|function=signature_ms] 参数名 描述
     * @param_httpquery string[len=50|required=0] 参数名 描述
     * @param_httpquery string[len=10,] 参数名 描述 //中括号里不允许有空格
     * @param_httpquery mixed 参数名 描述
     * @param string 一维键[二维键1] 描述
     * @param float|int 一维键[二维键2] 描述
     * @param string|int 参数名 描述
     * @param string_json 参数名 描述 //json格式的字符串
     * @param file 参数名 描述 //一般是上传文件时，内容一般是二进制数据
     * @body_encode 方法名 //请求body格式化，发起请求前最后一步触发
     * @response_decode 解析方法名 //对响应结果做解析
     * @response_param string 返回参数名1 描述1
     * @response_param int 返回参数名2 描述2
     * @response_error 错误码1 描述
     * @response_error 错误码2 描述
     * @response_error 错误码3 描述
     * @demo 示例名 {request:xxx,response:xxx}
     * @demo_request demo1名 示例名 描述
     * @demo_request demo1名 示例名 描述
     * @demo_response demo1名 示例名 描述
     * @demo_request demo2名 示例名 描述
     * @demo_response demo2名 示例名 描述
     * @return int
     */
    public function postRawMethod()
    {
        return 1;
    }

    /**
     * get方法名称
     *
     * @desc 这是描述这是描述这是描述，这是描述
     *
     * @url /site/get-method
     * @method GET
     * @params [['key' => 'id', 'value' => '1' , 'description' => 'xx', 'default' => 'chen']]
     * @return int id
     */
    public function getMethod()
    {
        return 1;
    }

    /**
     * 接口名称
     *
     * @namespace /ddd/fff/或中文 //目录结构，用于文档平台菜单等地方
     * @desc 描述啊描述
     * 这是描述这是描述这是描述，这是描述
     * 多行描述
     * 很多行描述
     * @author chen //作者
     * @create_time 2019/9/19 //创建时间
     * @protocol http //请求协议
     * @host ms.geto.pro //接口官方域名，测试域名应由测试用例中自己修改
     * @url /site/post-form-method //请求资源地址
     * @method POST //请求类型
     * @header 键名1 键值1 描述描述
     *       描述描述描述描述描述描述
     *       很多很多描<a href="/ddd/fff/234" target="_blank">述描述描述</a>描述描述描述描述描述描述描述
     * @header 键名2 键值2 描述
     * @param_query string[len=10,30|required=1|default=123|function=signature_ms] 参数名 描述
     * @param_httpquery string[len=50|required=0] 参数名 描述
     * @param_httpquery string[len=10,] 参数名 描述 //中括号里不允许有空格
     * @param_httpquery string 参数名 描述
     * @param string 一维键[二维键1] 描述
     * @param float 一维键[二维键2] 描述
     * @param string 参数名 描述
     * @param string_json 参数名 描述 //json格式的字符串
     * @param file 参数名 描述 //一般是上传文件时，内容一般是二进制数据
     * @body_encode 方法名 //请求body格式化，发起请求前最后一步触发
     * @response_decode 解析方法名 //对响应结果做解析
     * @response_param string 返回参数名1 描述1
     * @response_param int 返回参数名2 描述2
     * @response_error 错误码1 描述
     * @response_error 错误码2 描述
     * @response_error 错误码3 描述
     * @demo 示例名 {request:xxx,response:xxx}
     * @return []
     */
    public function postFormMethod()
    {
        return [];
    }

}